Repository navigation
docs: predefine LIBZIM_WITH_XAPIAN for Doxygen to include Xapian meth… - #1136
Conversation
|
Hi @kelson42, if you have some time, please approve the workflow run. Thank you |
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The focused configuration changes correctly expose conditional Xapian APIs during documentation builds.
Review effort: Balanced
Findings: None
What changed in this PR
Updates documentation generation so Xapian-dependent APIs appear in Read the Docs.
Changes:
- Configures Doxygen preprocessing and Xapian macro definitions.
- Installs Doxygen in the Read the Docs environment.
| File | Description |
|---|---|
docs/conf.py |
Enables preprocessing and predefined macros. |
.readthedocs.yaml |
Adds the Doxygen system package. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1136 +/- ##
=======================================
Coverage 56.72% 56.72%
=======================================
Files 100 100
Lines 5056 5056
Branches 2239 2239
=======================================
Hits 2868 2868
Misses 714 714
Partials 1474 1474 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
Hi @kelson42 just checking in on this, all checks are passing and it is approved please tell me if there is anything else that I need to provide before it can be merged. Thank you! |
|
@Sriram-Nambiar Sorry for my lack of feedback. It has been reviewed and I will merge it. Thank you very much! |
Fixes #959
When generating documentation, Doxygen evaluates
#if defined(LIBZIM_WITH_XAPIAN)as false because the macro is not defined in the Doxygen configuration. Consequently, all Xapian-dependent methods (such aszim::setICUDataDirectoryand Xapian search/suggestion APIs) were missing from the generated ReadTheDocs documentation.Changes
docs/conf.py: Enabled Doxygen preprocessing and macro expansion, and predefinedLIBZIM_WITH_XAPIAN=1andLIBZIM_API=..readthedocs.yaml: Ensureddoxygenis installed in the build container viaapt_packages.